QueryAccount

The QueryAccount web service XML- or JSON-based information exchange systems that use the Internet for direct application-to-application interaction. These systems can include programs, objects, messages, or documents. enables an external client system to query an Account In the Cloud Monetisation Platform, a billing entity that can be used to manage payments on one or more subscriptions or payments for services. An account can hold details such as payments or invoices. and retrieve Account Summary details for any existing CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. Account.

The request supplies the Account Number of the account and a set of flags that determine the level of detail required.

The user A person with the capability to log in to the CMP GUI software, such as a customer service advisor or agent. must pass in a valid CMP Account Number in order to retrieve the associated Account details.

Datasets exist for this web service which enables the user to pass in a single value in order to retrieve a specific subset of information. The response returns basic details similar to AgentView The graphical user interface of the CMP that is typically used by Customer Service Agents to access CMP customer and billing data. In versions prior to CMP 8.0, this was called the CMP GUI. Account Summary, plus optional extra information determined by the datasets specified.

Submitting invalid data in the request will result in an error message. Neither Open Transaction information nor Open Events information is returned.

QueryAccount Request

The QueryAccount tag instructs the Account Service to query an Account. This request contains the following elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	The client may use this identifier to correlate the request and the response.	Optional
AccountNumber	Integer8	The number automatically allocated to the Account when created in CMP.	Mandatory
Datasets	Container	Contains one or more Dataset elements. The following datasets can be specified (note the upper case): ATTRIBUTES BASIC ACCOUNT_TYPE_AND_USAGE ADDRESS AUTO_PAYMENTS CREDIT_CONTROL CUSTOMER_DETAILS DISCOUNTS NON_SUBSCRIPTION_INVOICE PAYMENT_DETAILS SUBSCRIPTION_INVOICE ACCOUNT_SERIAL_NUMBERS SERVICES BONDS CREDIT_DEBIT_CARDS TERMINATION_FEE REWARD_ENTITLEMENTS DLP_PORT	Optional

Element Name

Content Type

Description

Required?

ExternalReference

String69

The client may use this identifier to correlate the request and the response.

Optional

AccountNumber

Integer8

The number automatically allocated to the Account when created in CMP.

Mandatory

Datasets

Container

Contains one or more Dataset elements. The following datasets can be specified (note the upper case):

ATTRIBUTES
BASIC
ACCOUNT_TYPE_AND_USAGE
ADDRESS
AUTO_PAYMENTS
CREDIT_CONTROL
CUSTOMER_DETAILS
DISCOUNTS
NON_SUBSCRIPTION_INVOICE
PAYMENT_DETAILS
SUBSCRIPTION_INVOICE
ACCOUNT_SERIAL_NUMBERS
SERVICES
BONDS
CREDIT_DEBIT_CARDS
TERMINATION_FEE
REWARD_ENTITLEMENTS
DLP_PORT

Optional

Datasets Request Container

The QueryAccount Dataset request container has the following elements:

Element Name	Content Type	Description	Required?
Element Name	Content Type	Description	Required?
Dataset	Container	The valid datasets are (note the upper case): ATTRIBUTES BASIC ACCOUNT_TYPE_AND_USAGE ADDRESS AUTO_PAYMENTS CREDIT_CONTROL CUSTOMER_DETAILS DISCOUNTS NON_SUBSCRIPTION_INVOICE PAYMENT_DETAILS SUBSCRIPTION_INVOICE ACCOUNT_SERIAL_NUMBERS SERVICES BONDS CREDIT_DEBIT_CARDS TERMINATION_FEE REWARD_ENTITLEMENTS DLP_PORT	Mandatory

Element Name

Content Type

Description

Required?

Element Name

Content Type

Description

Required?

Dataset

Container

The valid datasets are (note the upper case):

ATTRIBUTES
BASIC
ACCOUNT_TYPE_AND_USAGE
ADDRESS
AUTO_PAYMENTS
CREDIT_CONTROL
CUSTOMER_DETAILS
DISCOUNTS
NON_SUBSCRIPTION_INVOICE
PAYMENT_DETAILS
SUBSCRIPTION_INVOICE
ACCOUNT_SERIAL_NUMBERS
SERVICES
BONDS
CREDIT_DEBIT_CARDS
TERMINATION_FEE
REWARD_ENTITLEMENTS
DLP_PORT

Mandatory

Sample QueryAccount Request

BASIC Dataset

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:def="http://mdsuk.com/ws/dise3g/account/definition">

<soapenv:Header/>

<soapenv:Body>

<def:QueryAccount>

<def:Request>

<Dataset>BASIC</Dataset>

</Datasets>

</def:Request>

</def:QueryAccount>

</soapenv:Body>

</soapenv:Envelope>

PAYMENT_DETAILS dataset

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:def="http://mdsuk.com/ws/dise3g/account/definition">

<soapenv:Header/>

<soapenv:Body>

<def:QueryAccount>

<def:Request>

<Dataset>PAYMENT_DETAILS</Dataset>

</Datasets>

</def:Request>

</def:QueryAccount>

</soapenv:Body>

</soapenv:Envelope>

QueryAccount Response

The QueryAccount response is the response to the QueryAccount Request. This contains the following elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	Returned unmodified in the response. The client may use this identifier to correlate the request and the response.	Optional
BASIC	Container	See Account Basic Response Container for details.	Optional
PAYMENT_DETAILS	Container	Choice of: Cheque PaymentCard DirectDebit SEPADirectDebit See PaymentDetails Response Container for details.	Optional
ADDRESS	Container	See Address Request Container for details.	Optional
AUTO_PAYMENTS	Container	See AutoPayments Response Container for details.	Optional
CREDIT_CONTROL	Container	See CreditControl Response Container for details.	Optional
ACCOUNT_TYPE_AND_USAGE	Container	See AccountTypeAndUsage Response Container for details.	Optional
ACCOUNT_SERIAL_NUMBERS	Container	0-999 repetitions of AccountSerialNumber. See AccountSerialNumber Response Container for details	Optional
CUSTOMER_DETAILS	Container	See CustomerDetails Response Container for details.	Optional
SUBSCRIPTION_INVOICE	Container	See SubscriptionInvoiceControl Response Container for details.	Optional
NON_SUBSCRIPTION_INVOICE	Container	See NonSubscriptionInvoiceControl Response Container for details.	Optional
SERVICES	Container	See Service Response Container for details.	Optional
CREDIT_DEBIT_CARDS	Container	See CreditDebitCard Response Container for details	Optional
ATTRIBUTES	Container	See AttributeGroup Response Container for details.	Optional
TERMINATION_FEE	Container	See TerminationFee Response Container for details.	Optional
DLP_PORT	Container	See DLPPORT Response Container for details.	Optional

AccountBasic Response Container

The AccountBasic response container is the response to the BASIC dataset when specified in the QueryAccount request. It has the following elements:

Element Name	Content Type	Description	Required?
AccountNumber	Integer8	The number automatically allocated to the Account upon creation in CMP.	Mandatory
CorporateCode	String6	The Corporate to which the Account will be added. If not specified, the Account will not be associated with any Corporate.	Optional
GroupCode	String6	The ID allocated to the group in CMP to which the Account belongs.	Optional
CompanyNumber	String3	The Company Name to which the Account is attached.	Mandatory
PaymentType	String6	If not supplied, the value that is defaulted in comes from the Company Maintenance, Default Payment Type field. A list of valid payment types is configured in CMP setup. The payment type drives what the valid payment terms are. The list of payment types presented are governed by whether the redirect payment feature is being used. The PaymentType field determines the required payment details to be supplied. Each payment type is associated via setup with a payment method. The payment methods are: Direct Debit Credit Card Debit Card Electronic Funds Transfer Cheque Awaiting DD Instruction	Mandatory
PaymentTerms	String3	If not supplied, the value that is defaulted in comes from the Account Default Parms Maint. The field is ADVPaymentTermsAR. If there is a default payment term specified in the default payment terms for the payment type then that is used instead. The payment terms that are valid depend on the PaymentType and CompanyNumber that were provided.	Mandatory
BondAmount	Integer8	The total value of the bond is displayed only if a bond is currently being held for the customer.	Optional
AddressNumber	Integer8	The Account level delivery address number which is used to identify one of the several delivery addresses available.	Mandatory
CreationDate	dateTime	The date on which the Account was created.	Mandatory
SuspendFromInvoicing	Boolean	If set to True then invoicing is suspended on the Account.	Optional
LastAmendedDate	dateTime	The date and time at which the Account was last amended. YYYY-MM-DDThh:mm:ssZ	Optional
ParentSubscription	Integer8	The CMP Subscription Number of the parent.	Optional

Address Response Container

The Address response container is the response to the ADDRESS dataset when specified in the QueryAccount request. It has the following elements:

Element Name	Content Type	Description	Required?
AddressNumber	Integer	The Account level delivery address number which is one of the several delivery addresses available.	Optional
PersonalAddress	Container	The PersonalAddress container is returned when populated in CMP.	Optional
BusinessAddress	Container	The BusinessAddress container is returned when populated in CMP.	Optional
Last Amended Date	dateTime	The date and time at which the Account was last amended. YYYY-MM-DDThh:mm:ssZ	Optional

Only one address type, personal or business, can be setup at any one time. Therefore only the address which is populated in CMP is returned when an Account is queried specifying the ADDRESS dataset.

PersonalAddress Response Container

Element Name	Content Type	Description	Required?
Title	String10	The customer's appropriate title for example Mr, Mrs, Miss, Ms or Dr. This field is always mandatory but can be made optional via configuration if required.	Mandatory
Forename	String50	Customer's first name.	Optional
MiddleName	String20	Customer's middle name.	Optional
Surname	String50	Customer's surname.	Mandatory
Address1	String60	Line one of the customer's address.	Mandatory
Address2	String60	Line one of the customer's address.	Optional
Address3	String60	Line one of the customer's address.	Optional
Address4	String60	Line one of the customer's address.	Optional
Address5	String60	Line one of the customer's address.	Optional
Postcode	String10	Customer's post code. Must be entered without spaces.	Optional
DateOfBirth	Date	Customer's date of birth, in the format YYYY-MM-DD.	Optional
Gender	String	Choice of: Male, Female, Unknown or BLANK.	Optional
MaritalStatus	String	Choice of: Married, Single, Widowed, Divorced, Other, Separated or BLANK.	Optional
DateOfResidence	Date	The date from which the customer has lived at the address specified, in the format YYYY-MM-DD.	Optional
CustomerType	String10	Selected from one of the available Customer Types configured in CMP.	Optional
AddressType	String10	Identifies if the customer is a home owner, renting, living with parents, council tenant etc. Configurable CMP list.	Optional
AddressCategory	String10	Indicates property value. A category range relating to the address. Configurable CMP list.	Optional
Occupation	String10	The customer's current occupation. Configurable CMP list.	Optional
IDType	String10	The available type of ID used as proof of identity for example passport or driving license. Configurable CMP list.	Optional
IDNumber	String30	The unique ID from the proof of identity.	Optional
TelephoneNumber	String15	Customer's main contact telephone number.	Optional
EveningTelephoneNumber	String15	Customer's additional telephone number they can be reached on.	Optional
FaxNumber	String15	Customer's fax number.	Optional

CMP configuration controls which elements are mandatory and optional. Standard validation settings can be changed via CMP back office setup: DISESETUP > 5. Subscriber Registration Set up > 15. Delivery Address Set Up > 8. Field Validation Maintenance. Enter 'P' for Personal Address.

BusinessAddress Response Container

Element Name	Content Type	Description	Required?
CompanyName	String60	Name of company.	Mandatory
Address1	String40	Line one of the company's address.	Mandatory
Address2	String40	Line two of the company's address.	Optional
Address3	String40	Line three of the company's address.	Optional
Address4	String40	Line four of the company's address.	Optional
Address5	String40	Line five of the company's address.	Optional
Postcode	String10	Company's postcode. Must be entered without spaces.	Optional
CompanyTelephoneNumber	String15	Company's main contact telephone number.	Optional
ContactTelephoneNumber	String15	The individual's contact telephone number.	Optional
FaxNumber	String15	Company's fax number	Optional
CompanyType	String10	Indicates the type of company. Configurable CMP list.	Optional
AddressType	String10	Identifies the company's address. Configurable CMP list.	Optional
AddressCategory	String10	Indicates property value. A category range relating to the address can be configured. Configurable CMP list.	Optional
IndustrialClassificationCode	String10	Indicates the industry the company resides. Configurable CMP list.	Optional
CompanyRegistration	String25	Unique ID the company is registered to.	Optional
DateOfIncorporation	Date	The date the company register at the address specified, in the format YYYY-MM-DD.	Optional
Title	String10	Company's contact title.	Optional
Forename	String15	Company's contact first name.	Optional
MiddleName	String10	Company's contact middle name.	Optional
Surname	String25	Company's contact surname name.	Optional
JobTitle	String30	Company's contact job title.	Optional

PaymentDetails Response Container

The PaymentDetails response container is the response to the PAYMENT_DETAILS dataset when specified in the QueryAccount request. It has the following elements:

Element Name	Content Type	Description	Required?
Cheque	Container	See Cheque Response Container for details.	Mandatory
PaymentCard	Container	See PaymentCard Request Container for details.	Mandatory
DirectDebit	Container	See DirectDebit Response Container for details.	Mandatory
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

Cheque Response Container

The Cheque response container has the following elements:

Element Name	Content Type	Description	Required?
PaymentType	String6	A PaymentType which has a Payment Method of Cheque is referred to as a manual payment. In this case payments are taken outside CMP and can be recorded in CMP or a third party accounting system at a later point. Manual payments require no extra payment information.	Mandatory

PaymentCard Response Container

The PaymentCard response container has the following elements:

Element Name	Content Type	Description	Required?
PaymentType	String6	The type of credit / debit card used (for example VISA).	Mandatory
CardNumber	String20	Only the last four digits of the credit/debit card number are displayed in line with PCI DSS compliance	Optional
NameOnCard	String20	The cardholder's name, exactly as it appears on the card.	Optional
PaymentCardStatus	String6	This indicates if the card is active or not.	Optional

DirectDebit Response Container

The DirectDebit response container has the following elements:

Element	Content Type	Description	Required?
BankName	String30	The name of the bank, for example Barclays.	Optional
NameOfPayer	String30	The name of the person instigating the direct debit. Typically in the format Forename Surname.	Optional
DateMandateReceived	Date	The date that the direct debit mandate was received in the format YYYY-MM-DDZ. For electronic forms of direct debit mandate this should be set to the current date. For paper mandates, use the date that the mandate was received.	Optional
DirectDebitPaymentStatus	String6	This field is deprecated and is no longer used.	Optional
DDSetupMethodCode	String6	The unique code for the set up method used. For example, PDD - Paperless Direct Debit (Phone).	Optional
PaymentType	String	The default Payment Type (e.g. Direct Debit).	Mandatory
BankAccountNumber	String20	The bank account from which the payments will be made.	Optional
BankSortCode	String20	The sort code for the bank branch which holds the account.	Optional

This approach to required fields matches the current approach for the Update Recurring Payment Details web service. All fields are defined as optional which supports the usage The consumption of services, for example a subscriber using call minutes. for changing details of the existing payment method. However if the web service is being used to change the payment method then some of the optional fields have to be populated to enable the payment method to be setup.

AutoPayments Response Container

The AutoPayments response container is the response to the AUTO_PAYMENTS dataset when specified in the QueryAccount request. It has the following elements:

Element Name	Content Type	Description	Required?
AutoPaymentCalcMethod	String - enumeration	There are two options for this field which refers to direct debit/automatic account withdrawals only. CHILD (Child balance) PARENT (Parent balance). If set to CHILD, only payments corresponding to the Account being changed are pulled. If set to PARENT, payments are pulled from all Accounts linked to the parent of the Account being viewed.	Optional
Suspend FromAuto Payment	Boolean	Once flagged the auto payment is suspended.	Optional
SuspendUpToDueDate	date	The date, in the format YYYY-MM-DDZ, entered relates to the start of the period during which auto payments are suspended. Works in conjunction with Suspend FromAuto Payment field.	Optional
SuspendDueDateUntil	date	The date, in the format YYYY-MM-DDZ, entered relates to the end of the period during which auto payments are suspended. Works in conjuction with Suspend FromAuto Payment field.	Optional
SuspensionReason	String90	The reason why the Account is suspended from auto payment. Works in conjunction with Suspend FromAuto Payment field.	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

CreditControl Response Container

The CreditControl response container is the response to the CREDIT_CONTROL dataset when specified in the QueryAccount request. It has the following elements:

Element Name	Content Type	Description	Required?
CreditLimit	Integer9	The customers spending limit. This includes billed charges and can work independently, or in conjunction with the value of unbilled usage.	Optional
HardwareCreditLimit	Integer9	The customer spending limit for hardware only.	Optional
CreditScore	Integer	The rating given to the customer by the Credit Reference Agency during the credit checking process.	Optional
IgnoreCreditControl	Boolean	This suspends the Credit Control process up to a specified date, see IgnoreCreditControlUpToDate. This setting can also be changed by the CreditControlStatus setting.	Optional
IgnoreCreditControlUpToDate	Date	The date until which Credit Control is ignored. Works in conjunction with IgnoreCreditControl. This setting is also used by the CreditControlStatus setting. YYYY-MM-DDZ	Optional
IgnoreUsageLimits	Boolean	If set to True, this means the customer is not notified when either their lower or upper usage limit is reached, and no auto response is triggered. This affects all Subscriptions linked to the Account.	Optional
AccountInQuery	Boolean	If set to True, this indicates that an element of the balance outstanding is being held out from recovery procedures while a customer query is addressed.	Optional
CreditControlAddressNumber	Integer8	The unique number associated with this type of address, which is one of several delivery addresses available in CMP.	Optional
CreditControlStatus	String	Choice of: Normal – The Account is not currently in credit control. On Procedure – The Account is in credit control. Ignored – The Account was in credit control but an agent has indicated that this is to be ignored. The IgnoreCreditControl flag will be set to true in this case as well. Ignored Until – The Account was in credit control but an agent has indicated that it is to be ignored until a date specified in the IgnoreCreditControlUpToDate field above.	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

Account Type and Usage Response Container

The AccountTypeAndUsage response container is the response to the ACCOUNT_TYPE_AND_USAGE dataset when specified in the QueryAccount request. It has the following elements:

Element Name	Content Type	Description	Required?
AccountType	String6	Account Types indicate the type of account to which Subscriptions belong. This is a classification of the Account. If not supplied, the value that is defaulted in comes from the Account Default Parms Maint. The field is ADVSalesPersonCode.	Optional
SubLedgerCode	String6	This references an extra level of detail in the General Ledger and links to the external financials software. The main use of this code is to enable direct debits to be claimed from the bank account. If not supplied, the value that is defaulted in comes from the Subledger field in Account Default Parms Maint.	Optional
AccountUsage	String - Enumeration	This indicator controls what the account can be used for. Possible values are: Subscription Sales SubscriptionAndSales (default) Subscriptions cannot be added to an Account when usage is Sales (usually referred to as a Hardware account). It is possible to add Subscriptions to a Subscription or to a SubscriptionAndSales (Both).	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

AccountSerialNumbers Response Container

The AccountSerialNumbers response container is the response to the ACCOUNT_SERIAL_NUMBERS dataset when specified in the QueryAccount request. It has the following elements:

Element Name	Content Type	Description	Required?
SerialNumberId	Range 1-999	The serial number identification number.	Mandatory
SerialNumberValue	String25	The actual serial number value for example 07712345678.	Mandatory
EffectiveDate	Date	The date from which the serial number becomes effective. YYYY-MM-DDZ	Optional
SerialStatus	String	The serial number status. Possible values are: CHANGING CURRENT SUPERSEDED	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

CustomerDetails Response Container

The CustomerDetails response container is the response to the CUSTOMER In the context of the Cloud Monetisation Platform, an individual or organisation who has signed an agreement to take goods and services from a service provider. A customer receives a bill associated with one or more subscriptions, and can be a single end user or a large company with many subscriptions assigned to one agreement._DETAILS dataset when specified in the QueryAccount request. It has the following elements:

Element Name	Content Type	Description	Required?
AccountPassword	String20	This is used for security purposes if it is necessary to control caller access. This password can work instead of, or in conjunction with, a Subscription password.	Optional
AccountPIN	Integer4	System generated unique personal identification number. Active if Interactive Voice Recognition (IVR) is introduced.	Optional
ForAttnOfName	String30	Details of the name that appears on statements, copy invoices, etc.	Optional
AccountContactName	String30	Details of a personal contact within the customer's organisation.	Optional
CustomerCostCentre	String20	Codes are used to allocate responsibility of charges to different areas within an organisation. The customer purchase ledger cost centre can be entered here to be printed on all invoices. New cost centres can be added to the list at Agreement level.	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

SubscriptionInvoiceControl Response Container

The SubscriptionInvoiceControl response container is the response to the SUBSCRIPTION A billing entity that incurs a charge. Examples include a network attached device whose usage you want to measure and charge for, or a monthly software subscription_INVOICE dataset when specified in the QueryAccount request. It has the following elements:

Element Name	Content Type	Description	Required?
GenericText	Boolean	This allows standard text messages to appear on the invoice. If set to True, any company notices, instructions, warnings, etc. appear on all invoices produced.	Optional
OverrideTaxCode	Boolean	If set to True, the tax code on specific services is ignored. Instead the tax code from the Account level within the external finance package customer file is used.	Optional
PrintStatement	Boolean	If set to True, statements for non-subscription related services are issued. Otherwise they are included within the usage invoice.	Optional
BillingMediaCode	String6	Account = Non-subs invoicing (Adjustments / Orders etc)	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

NonSubscriptionInvoiceControl Response Container

The NonSubscriptionInvoiceControl response container is the response to the NON_SUBSCRIPTION_INVOICE dataset when specified in the QueryAccount request. It has the following elements:

Element Name	Content Type	Description	Required?
PrintStatement	Boolean	If set to True, statements for Non-Subscription related Services are issued. Otherwise they are included within the usage invoice.	Optional
PrintStatementBillingMediaCode	String6	This indicates the medium used to issue Non-Subscription Statements.	Optional
ConsolidateInvoice	Boolean	When Invoice Print is run, if ConsolidateInvoice is set to True, the relevant invoices are consolidated to Account level.	Optional
ConsolidateInvoiceBillingMediaCode	String6	This indicates the medium used to issue Non-Subscription consolidated Invoices.	Optional
FirstInvoice	Date	The date on which the first invoice was produced. YYYY-MM-DDZ	Optional
LastInvoice	Date	The date on which the previous invoice was produced. YYYY-MM-DDZ	Optional
NextExpectedInvoice	Date	The date of the next expected Invoice (as per billing cycle). YYYY-MM-DDZ	Optional
SubsequentInvoiceFrequency	Container	Choice of: SubsequentInvoiceFrequencyDays SubsequentInvoiceFrequencyMonths See SubsequentInvoiceFrequency Response Container Response for further information.	Optional
DelayToCycle	Integer	A Non-Subscription invoice can be aligned to be produced on the same day as the usage invoice. This element indicates if a Non-Subscription invoice is produced at the same time as the usage invoice.	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

SubsequentInvoiceFrequency Response Container

The SubsequentInvoiceFrequency response container has the following elements:

Element Name	Content Type	Description	Required?
SubsequentInvoiceFrequencyDays	Integer	This indicates the number of days between each invoice date. Min Inclusive: 1 Max Inclusive: 31	Optional
SubsequentInvoiceFrequencyMonths	Token	This indicates the number of months between each invoice date. [0] [1-9] [1] [0-2]	Optional

Element Name

Content Type

Description

Required?

SubsequentInvoiceFrequencyDays

Integer

This indicates the number of days between each invoice date.

Min Inclusive: 1
Max Inclusive: 31

Optional

SubsequentInvoiceFrequencyMonths

Token

This indicates the number of months between each invoice date.

[0] [1-9]
[1] [0-2]

Optional

Services Response Container

The Services response container is the response to the SERVICES dataset specified in the QueryAccount request. It has the following elements:

Element Name	Content Type	Description	Required?
Service	Container	See Service Response Container for details.	Optional

Service Response Container

The Service response container has the following elements:

Element Name	Content Type	Description	Required?
ServiceCode	String6	This details the code attributed to the Service as it appears on the invoice.	Mandatory
PackageCode	String6	The unique code within a company used to identify which Package the service is linked to.	Optional
Package Description	String30	The descriptive name for the Package that the service is linked to.	Optional
Description	String30	This details the descriptive text (30-characters) attributed to the Service as it appears on the invoice.	Optional
ServicePrice	Currency (Decimal)	The price of the Service. Min Inclusive: 0.01 Max Inclusive: 999999999.99	Optional
EffectiveDate	Date	This is the date from which the Service becomes effective. YYYY-MM-DDZ	Optional
ExpiryDate	Date	This is the date on which the Service is set to expire. YYYY-MM-DDZ	Optional
IncdInTermCostCalc	Boolean	This indicates if a particular Service is included in the termination cost calculation.	Optional
PriceConsolidationService		Applicable to Subscription Services only. This enables the chosen Service to become part of one consolidated Service, which is several chargeable Subscription Services grouped together to appear on the Subscription invoice as one Service with one charge or price against it.	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

A Service container is returned for each active Account Service.

Card Response Container

The Card response container is the response to the CREDIT_DEBIT_CARDS dataset when specified in the QueryAccount request. It has the following elements:

Element Name	Content Type	Description	Required?
SubscriptionNumber	Integer8	The unique system generated Reference Number for the Subscription.	Optional
NetworkSerialNumber	String25	Network Serial Number associated with CMP Subscription Number.	Optional
PaymentType	String6	The type of credit / debit card to be used (for example VISA).	Mandatory
Status	String	One of the following: OneOffPayment – Indicates that the card is for one off payments Active – Indicates that the card is for recurring payments.	Mandatory
CardReference	VARCHAR(100)	The tokenised string representing the card.	Mandatory
CardNumber	String4	The last four digits of card number.	Optional
NameOnCard	String20	The name that appears on the card.	Optional
StartYear	String2	Start year on the card.	Optional
StartMonth	String2	Start month on the card.	Optional
ExpiryYear	String2	Expiry year on the card.	Optional
ExpiryMonth	String2	Expiry month on the card.	Optional

AttributeGroup Response Container

The AttributeGroup response container is the response to the ATTRIBUTES dataset when specified in the QueryAccount request. It returns the following processing results:

Element Name	Content Type	Description	Required?
AttributeGroupID	String6	A unique ID for the Attribute Group. For example, 03A. Each account can have only a single effective Attribute Group at any one time	Mandatory
EffectiveDate	dateTime	The date from which the Attribute Group becomes effective. YYYY-MM-DDThh:mm:ssZ	Optional
Attribute	Container	Attributes are a configurable list of values that can be associated with entities such as Price Plans and Packages to provide more information on it. See Attribute Response Container for details.	Mandatory

Element Name

Content Type

Description

Required?

AttributeGroupID

String6

A unique ID for the Attribute Group. For example, 03A.

Each account can have only a single effective Attribute Group at any one time

Mandatory

EffectiveDate

dateTime

The date from which the Attribute Group becomes effective.

YYYY-MM-DDThh:mm:ssZ

Optional

Attribute

Container

Attributes are a configurable list of values that can be associated with entities such as Price Plans and Packages to provide more information on it.

See Attribute Response Container for details.

Mandatory

Attribute Response Container

The Attribute response container has the following elements:

Element Name	Content Type	Description	Required?
AttributeID	Integer2	A unique ID for the Attribute. For example, 01. This is chosen from a list of Attributes configured against the chosen Attribute Group in CMP diseMP Back Office configuration.	Mandatory
AttributeValue	String120	A full Description of the Attribute. For example, Dedicated Lease Line Connection.	Optional
EffectiveDate	dateTime	The date on which the Attribute becomes effective. YYYY-MM-DDThh:mm:ssZ	Optional

Element Name

Content Type

Description

Required?

AttributeID

Integer2

A unique ID for the Attribute. For example, 01.

This is chosen from a list of Attributes configured against the chosen Attribute Group in CMP diseMP Back Office configuration.

Mandatory

AttributeValue

String120

A full Description of the Attribute.

For example, Dedicated Lease Line Connection.

Optional

EffectiveDate

dateTime

The date on which the Attribute becomes effective.

YYYY-MM-DDThh:mm:ssZ

Optional

TerminationFee Response Container

The TerminationFee response container is the response to the TERMINATION_FEE dataset when specified in the QueryAccount request. It has the following elements:

Element Name	Content Type	Description	Required?
TerminationFee	Currency (Decimal)	Monetary value that will be charged if a subscriber decides to leave their contract early.	Optional

DLPPorts Response Container

The DLPPorts response container is the response to the DLP_PORT dataset when specified in the QueryAccount request. It has the following elements:

Element Name	Content Type	Description	Required?
SubscriptionNumber	Integer8	The Subscription Number that has port in information associated with it. Each Subscription may have more than one Port-in returned (if for instance a pending Port-in was cancelled and then initiated again).	Mandatory
PACCode	String9	Standard PAC format.	Mandatory
PACExpiryDate	Date	The date that the PAC expires.	Mandatory
PACCreationDate	Date	The date on which the PAC was created on.	Mandatory
RNO	String2	The Recipient Network Operator. This is the code that comes from Syniverse.	Optional
DNO	String2	The Donor Network Operator. This is the code that comes from Syniverse.	Mandatory
RSP	String3	The Recipient Service Provider. This is the code that comes from Syniverse.	Optional
DSP	String	The Donor Service Provider. This is the code that comes from Syniverse.	Mandatory
PortDate	Date	YYYY-MM-DDZ The date on which the number is scheduled to Port-in.	Optional
PortStatus	Enumeration	The current status of the Port-in. Possible values for PortStatus are as follows: CLOSED - This is the status of the port after the customer has agreed to Port-in but prior to porting. The Port-in will retain this status until between 18:00 and22:00 on the day before. LOCKED – This is the PAC status between 18:00 and 21:00 on the day before. This status will only be displayed in the Online Portal if an agent queries Syniverse between 18:00 and 21:00, and the customer subsequently looks at the Port ins on the Online Portal. The web service does not query Syniverse unless an agent explicitly does so, the CLOSED status will be returned. IN_PROGRESS – This is the status in which the Port-in will be from 22:00 on the day before the Port-in until the Port-in event is completed. COMPLETE - This is the status when Port-in commands have been sent to the network and CMP has received a successful response. CANCELLED – Indicates a Port-in request was cancelled. ERROR - This is the status of the Port-in once the Port-in has been completed but CMP has received an error.	Mandatory
Cancellable	Boolean	This indicates whether or not it is possible to cancel a CLOSED PAC (an in progress Port-in). This only affects online Port-ins. Changes will still be allowed via AgentView until rejected by Syniverse.	Optional
NumberBeingPortedIn	String25	The mobile number being ported in.	Mandatory
NumberBeingReplaced	String25	The mobile number that is being replaced. This is not available when the PortStatus = COMPLETE.	Optional